home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / CDTV / cdxltools3-11 / ReadMe < prev    next >
Encoding:
Text File  |  1992-03-13  |  7.3 KB  |  193 lines
  1.                          CDXL(TM) LOADER AND SAVER
  2.                                 FOR ASDG'S
  3.                       ART DEPARTMENT PROFESSIONAL(TM)
  4.  
  5. THE ART DEPARTMENT PROFESSIONAL MODULES DESCRIBED IN THIS DOCUMENT (AS WELL
  6. AS  THIS  DOCUMENT ITSELF) ARE PROPRIETARY AND ARE SUBJECT TO PROVISIONS OF
  7. THE  (1) CDTV(TM) DEVELOPER LICENSE AND (2) THE ART DEPARTMENT PROFESSIONAL
  8. END-USER SOFTWARE LICENSE AGREEMENT.
  9.  
  10. ---------------------------------------------------------------------------
  11.  
  12.          NOTE: USE OF THESE MODULES REQUIRES ADPRO 2.1.X OR LATER.
  13.  
  14. ---------------------------------------------------------------------------
  15.                                 The Loader
  16.  
  17.  THE LOADER REQUIRES "adpro.library" TO BE LOADED IN THE LIBS: DIRECTORY.
  18.                  THIS IS PERFORMED BY THE INSTALL PROGRAM
  19.  
  20. The ADPRO CDXL loader can load most of the image types that the CDXL format
  21. supports.  Specifically it supports 1-8 bit rendered data, HAM and EHB.  It
  22. also supports 8 bit gray and 24 bit color chunky image data.  It allows you
  23. to  load  (preserve)  audio  and  pad  data  from existing CDXL files which
  24. include such information.
  25.  
  26. The  CDXL  loader is special in that it stays resident after its first use.
  27. And,  when used from ARexx, it can also keep open the last file used.  This
  28. allows the loader to process animations extremely quickly.
  29.  
  30. The  CDXL  Loader  main  window  gives you the number of frames in the CDXL
  31. file,  and  the number of bytes per frame of audio and pad data.  It allows
  32. you  to  select which frame to load.
  33.  
  34. Along  the bottom of the window, "Accept" loads the selected frame.  "Quit"
  35. ,  closes  the  file  and quits the loader (meaning that the loader will be
  36. removed  from  memory).  Finally, "Cancel", cancels the load but leaves the
  37. loader resident and the last used CDXL file open.
  38.  
  39. If the pre-existing CDXL file contains pad and/or audio data, you can choose
  40. to  load  that data or not.  If loaded, this information will be saved with
  41. the frame during the next CDXL save provided that the CDXL file being saved
  42. has  made  provisions for audio and pad data of the same size as the source
  43. CDXL file.
  44.  
  45. From AREXX, you interface to the CDXL loader in the following way:
  46.  
  47.     The general format of the CDXL loader ARexx interface
  48.     is as follows:
  49.     LOAD "filename" "framenum" n [CMD] [standard ADPRO C_OPTS]
  50.         
  51.     where CMD is 0 or more of the following:
  52.  
  53.         SKIPPAD        do not load pad data
  54.  
  55.         SKIPAUDIO    do not load audio data
  56.  
  57.         SKIPVIDEO    do not load video (audio or pad only)
  58.  
  59.         KEEPOPEN    keep the file open.     SEE NOTE!!!
  60.  
  61.         CLOSE        close the file, and do nothing else
  62.  
  63.         QUIT        close the file, and quit (unresident 
  64.                 the loader), do nothing else
  65.  
  66.         NOPAD        do not convert rendered data to 8 bit 
  67.                 or 24 bit raw
  68.  
  69.     If you do not specify SKIPPAD or SKIPAUDIO, pad and audio will
  70.     be loaded, if present.
  71.  
  72. NOTE:    WHEN YOUR THROUGH WITH A FILE WHICH YOU EXPLICITLY ASKED TO
  73.     ``KEEPOPEN'',  YOU  MUST REMEMBER TO ISSUE A ``CLOSE'', OR RISK THE
  74.     FILE STILL BEING OPEN WHEN YOU REBOOT WITH POTENTIALLY HAZARDOUS
  75.     RESULTS
  76.  
  77. ---------------------------------------------------------------------------
  78.                                  The SAVER
  79.  
  80. The  ADPro  CDXL  Saver allows you to create, modify and extend CDXL files.
  81. It  allows  you  to  specify  the  amount  of  space to leave for audio and
  82. padding.   It, in conjunction with the CDXL loader, can even be used to copy
  83. audio and pad data from other CDXL files.
  84.  
  85. The  saver  may  be  used with 1-8 bit rendered data, HAM and EHB.  It also
  86. supports 8 bit gray and 24 bit color chunky image data.
  87.  
  88. The  CDXL  saver  is special in that it stays resident after its first use.
  89. When used from ARexx, it can keep open the last file used.  This allows the
  90. saver to process animations extremely quickly.
  91.  
  92. The CDXL Saver main window shows the number of frames (if any) currently in
  93. the  CDXL  file,  the amount of pad and audio space, and the type of image.
  94. If you are creating a new CDXL file, you are allowed to enter the amount of
  95. pad  and  audio  space,  and  well  as  the  type  of image - either raw or
  96. rendered.
  97.  
  98. There are two buttons which allow you to select how to handle audio and pad
  99. space  in  the  file.  Each button has 3 settings.  "Skip Audio" leaves the
  100. audio  data  in the file intact, "Zero Audio" clears the audio space, "Keep
  101. Audio"  saves  the  audio  data  that  the  CDXL  loader  may  have  loaded
  102. previously.   The  "Keep  Audio"  selection will not appear unless you have
  103. loaded  Audio  data,  and  it  appropriately sized.  The other button, with
  104. values  of  "Zero Pad", "Skip Pad" and "Keep Pad" serves the same functions
  105. for pad data.
  106.  
  107. Below  the  audio  and pad buttons in the Interleaved/Non-Interleaved image
  108. button  (this  button is only enabled if you are creating a new CDXL file).
  109. Beneath  this button is the button which allows you to pick rendered or raw
  110. data.
  111.  
  112. If you choose interleaved, and you choose rendered data, then the planes of
  113. rendered data are interleaved in the file.
  114.  
  115. If  you choose interleaved, and you choose raw data, then the format of the
  116. data is interleaved lines of of the three colors, red green blue.
  117.  
  118. If  you  choose  non-interleaved,  and  you  choose rendered data, then the
  119. planes of rendered data are saved one at a time.
  120.  
  121. If  you choose non-interleaved, and you choose raw data, then the format of
  122. the  data  is  as  triples  of  red,green,blue  bytes  in  a matrix of size
  123. width*height.
  124.  
  125. The  three  buttons  along  the  bottom  of  the  window, "Accept", "Quit",
  126. "Cancel",  respectively saves the selected frame, closes the file and quits
  127. the  saver,  cancels  the  save  but leaves the saver resident and the file
  128. open.
  129.  
  130. You  are  allowed  to  enter  a  frame number one larger than the number of
  131. frames in the file, thus extending the file by one frame.
  132.  
  133.  
  134. From AREXX, you interface to the CDXL saver in the following way:
  135.  
  136.     The general format of the CDXL saver ARexx interface
  137.     is as follows:
  138.         SAVE "filename" TYPE framenum n [CMD]
  139.  
  140.     Where TYPE may be one of 
  141.         RAW        save "raw" image data
  142.         IMAGE        save "rendered" image data
  143.  
  144.     where CMD is 0 or more of the following:
  145.  
  146.         FRAMENUM nn    -1 means append, else must be
  147.                 1..#of frames+1 in the file
  148.  
  149.         PADSPACE nn    allows you to pick pad space. If not
  150.                 creating a file, this number must agree with
  151.                 the existing padspace in the file. 
  152.  
  153.                 You must also specify SAVEPAD for PADSPACE
  154.                 to perform its work
  155.  
  156.         AUDIOSPACE nn    allows you to pick audio space. If not
  157.                 creating a file, this number must agree 
  158.                 with the existing audiospace in the file
  159.  
  160.                 You must also specify SAVEAUDIO for AUDIOSPACE
  161.                 to perform its work
  162.  
  163.         SKIPPAD        do not save pad data - leave this 
  164.                 frames pad intact
  165.  
  166.         SAVEPAD        save the loaded pad data into 
  167.                 this frame (sizes must match)
  168.  
  169.         ZEROPAD        clear the pad space of this frame to zeros
  170.  
  171.         SKIPAUDIO    do not save audio data - leave this 
  172.                 frames audio intact
  173.  
  174.         SAVEAUDIO    save the loaded audio data into this 
  175.                 frame (sizes must match)
  176.  
  177.         ZEROAUDIO    clear the audio space of this frame to zeros
  178.  
  179.         KEEPOPEN    keep the file open    SEE NOTE!!!
  180.  
  181.         CLOSE        close the file and do nothing else
  182.  
  183.         QUIT        close the file, and quit (unresident) 
  184.                 the saver and do nothing else
  185.  
  186.         INTERLEAVED    use "interleaved" format. If this 
  187.                 word is not present then save noninterleaved.
  188.                 
  189. NOTE:    WHEN YOUR THROUGH WITH A FILE WHICH YOU EXPLICITLY ASKED TO
  190.     ``KEEPOPEN'',  YOU  MUST REMEMBER TO ISSUE A ``CLOSE'', OR RISK THE
  191.     FILE STILL BEING OPEN WHEN YOU REBOOT WITH POTENTIALLY HAZARDOUS
  192.     RESULTS
  193.